<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2012 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: PersistentFileTransaction.html 973 2015-04-22 14:58:55Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.stuff.pobj;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.io.IOException;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.util.ArrayList;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import java.util.List;<a name="line.12"></a>
<span class="sourceLineNo">013</span><a name="line.13"></a>
<span class="sourceLineNo">014</span>import javax.xml.stream.XMLInputFactory;<a name="line.14"></a>
<span class="sourceLineNo">015</span>import javax.xml.stream.XMLStreamException;<a name="line.15"></a>
<span class="sourceLineNo">016</span>import javax.xml.transform.Source;<a name="line.16"></a>
<span class="sourceLineNo">017</span>import javax.xml.transform.Transformer;<a name="line.17"></a>
<span class="sourceLineNo">018</span>import javax.xml.transform.TransformerException;<a name="line.18"></a>
<span class="sourceLineNo">019</span>import javax.xml.transform.TransformerFactory;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import javax.xml.transform.dom.DOMResult;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import javax.xml.transform.dom.DOMSource;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import javax.xml.transform.stax.StAXSource;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.w3c.dom.Document;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>/**<a name="line.26"></a>
<span class="sourceLineNo">027</span> * Represents an open "transaction" on a {@link PersistentObject}'s persistent file.<a name="line.27"></a>
<span class="sourceLineNo">028</span> *<a name="line.28"></a>
<span class="sourceLineNo">029</span> * &lt;p&gt;<a name="line.29"></a>
<span class="sourceLineNo">030</span> * This class is used by {@link PersistentObjectSchemaUpdater} and would normally not be used directly.<a name="line.30"></a>
<span class="sourceLineNo">031</span> */<a name="line.31"></a>
<span class="sourceLineNo">032</span>public class PersistentFileTransaction {<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span>    private final XMLInputFactory xmlInputFactory = XMLInputFactory.newFactory();<a name="line.34"></a>
<span class="sourceLineNo">035</span>    private final ArrayList&lt;String&gt; updates = new ArrayList&lt;String&gt;();<a name="line.35"></a>
<span class="sourceLineNo">036</span>    private final String systemId;<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span>    private Document current;<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span>    /**<a name="line.40"></a>
<span class="sourceLineNo">041</span>     * Constructor.<a name="line.41"></a>
<span class="sourceLineNo">042</span>     *<a name="line.42"></a>
<span class="sourceLineNo">043</span>     * @param source XML input<a name="line.43"></a>
<span class="sourceLineNo">044</span>     * @throws PersistentObjectException if no updates are found<a name="line.44"></a>
<span class="sourceLineNo">045</span>     * @throws IllegalArgumentException if {@code source} is null<a name="line.45"></a>
<span class="sourceLineNo">046</span>     */<a name="line.46"></a>
<span class="sourceLineNo">047</span>    public PersistentFileTransaction(Source source) throws IOException, XMLStreamException {<a name="line.47"></a>
<span class="sourceLineNo">048</span>        this(source, null);<a name="line.48"></a>
<span class="sourceLineNo">049</span>    }<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span>    /**<a name="line.51"></a>
<span class="sourceLineNo">052</span>     * Constructor.<a name="line.52"></a>
<span class="sourceLineNo">053</span>     *<a name="line.53"></a>
<span class="sourceLineNo">054</span>     * @param source XML input<a name="line.54"></a>
<span class="sourceLineNo">055</span>     * @param transformerFactory transformer factory, or null for platform default<a name="line.55"></a>
<span class="sourceLineNo">056</span>     * @throws PersistentObjectException if no updates are found<a name="line.56"></a>
<span class="sourceLineNo">057</span>     * @throws IllegalArgumentException if {@code source} is null<a name="line.57"></a>
<span class="sourceLineNo">058</span>     */<a name="line.58"></a>
<span class="sourceLineNo">059</span>    public PersistentFileTransaction(Source source, TransformerFactory transformerFactory) throws IOException, XMLStreamException {<a name="line.59"></a>
<span class="sourceLineNo">060</span>        if (source == null)<a name="line.60"></a>
<span class="sourceLineNo">061</span>            throw new IllegalArgumentException("null source");<a name="line.61"></a>
<span class="sourceLineNo">062</span>        if (transformerFactory == null)<a name="line.62"></a>
<span class="sourceLineNo">063</span>            transformerFactory = TransformerFactory.newInstance();<a name="line.63"></a>
<span class="sourceLineNo">064</span>        this.systemId = source.getSystemId();<a name="line.64"></a>
<span class="sourceLineNo">065</span>        this.read(source, transformerFactory);<a name="line.65"></a>
<span class="sourceLineNo">066</span>    }<a name="line.66"></a>
<span class="sourceLineNo">067</span><a name="line.67"></a>
<span class="sourceLineNo">068</span>    /**<a name="line.68"></a>
<span class="sourceLineNo">069</span>     * Get the current XML data. Does not include the XML update list.<a name="line.69"></a>
<span class="sourceLineNo">070</span>     */<a name="line.70"></a>
<span class="sourceLineNo">071</span>    public Document getData() {<a name="line.71"></a>
<span class="sourceLineNo">072</span>        return this.current;<a name="line.72"></a>
<span class="sourceLineNo">073</span>    }<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span>    /**<a name="line.75"></a>
<span class="sourceLineNo">076</span>     * Get the system ID of the original source input.<a name="line.76"></a>
<span class="sourceLineNo">077</span>     */<a name="line.77"></a>
<span class="sourceLineNo">078</span>    public String getSystemId() {<a name="line.78"></a>
<span class="sourceLineNo">079</span>        return this.systemId;<a name="line.79"></a>
<span class="sourceLineNo">080</span>    }<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span>    /**<a name="line.82"></a>
<span class="sourceLineNo">083</span>     * Get the updates list associated with this transaction.<a name="line.83"></a>
<span class="sourceLineNo">084</span>     */<a name="line.84"></a>
<span class="sourceLineNo">085</span>    public List&lt;String&gt; getUpdates() {<a name="line.85"></a>
<span class="sourceLineNo">086</span>        return this.updates;<a name="line.86"></a>
<span class="sourceLineNo">087</span>    }<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span>    /**<a name="line.89"></a>
<span class="sourceLineNo">090</span>     * Apply an XSLT transform to the current XML object in this transaction.<a name="line.90"></a>
<span class="sourceLineNo">091</span>     *<a name="line.91"></a>
<span class="sourceLineNo">092</span>     * @throws IllegalStateException if the current root object is null<a name="line.92"></a>
<span class="sourceLineNo">093</span>     * @throws PersistentObjectException if an error occurs<a name="line.93"></a>
<span class="sourceLineNo">094</span>     * @throws TransformerException if the transformation fails<a name="line.94"></a>
<span class="sourceLineNo">095</span>     */<a name="line.95"></a>
<span class="sourceLineNo">096</span>    public void transform(Transformer transformer) throws TransformerException {<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span>        // Sanity check<a name="line.98"></a>
<span class="sourceLineNo">099</span>        if (this.current == null)<a name="line.99"></a>
<span class="sourceLineNo">100</span>            throw new PersistentObjectException("no data to transform");<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span>        // Set up source and result<a name="line.102"></a>
<span class="sourceLineNo">103</span>        final DOMSource source = new DOMSource(this.current, this.systemId);<a name="line.103"></a>
<span class="sourceLineNo">104</span>        final DOMResult result = new DOMResult();<a name="line.104"></a>
<span class="sourceLineNo">105</span>        result.setSystemId(this.systemId);<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>
<span class="sourceLineNo">107</span>        // Apply transform<a name="line.107"></a>
<span class="sourceLineNo">108</span>        transformer.transform(source, result);<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span>        // Save result as the new current value<a name="line.110"></a>
<span class="sourceLineNo">111</span>        this.current = (Document)result.getNode();<a name="line.111"></a>
<span class="sourceLineNo">112</span>    }<a name="line.112"></a>
<span class="sourceLineNo">113</span><a name="line.113"></a>
<span class="sourceLineNo">114</span>    private void read(Source input, TransformerFactory transformerFactory) throws IOException, XMLStreamException {<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span>        // Read in XML into memory, extracting and removing the updates list in the process<a name="line.116"></a>
<span class="sourceLineNo">117</span>        final UpdatesXMLStreamReader reader = new UpdatesXMLStreamReader(this.xmlInputFactory.createXMLStreamReader(input));<a name="line.117"></a>
<span class="sourceLineNo">118</span>        final StAXSource source = new StAXSource(reader);<a name="line.118"></a>
<span class="sourceLineNo">119</span>        final DOMResult result = new DOMResult();<a name="line.119"></a>
<span class="sourceLineNo">120</span>        result.setSystemId(this.systemId);<a name="line.120"></a>
<span class="sourceLineNo">121</span>        try {<a name="line.121"></a>
<span class="sourceLineNo">122</span>            transformerFactory.newTransformer().transform(source, result);<a name="line.122"></a>
<span class="sourceLineNo">123</span>        } catch (TransformerException e) {<a name="line.123"></a>
<span class="sourceLineNo">124</span>            throw new XMLStreamException("error reading XML input from " + this.systemId, e);<a name="line.124"></a>
<span class="sourceLineNo">125</span>        }<a name="line.125"></a>
<span class="sourceLineNo">126</span>        reader.close();<a name="line.126"></a>
<span class="sourceLineNo">127</span><a name="line.127"></a>
<span class="sourceLineNo">128</span>        // Was the update list found?<a name="line.128"></a>
<span class="sourceLineNo">129</span>        final List&lt;String&gt; updateNames = reader.getUpdates();<a name="line.129"></a>
<span class="sourceLineNo">130</span>        if (updateNames == null)<a name="line.130"></a>
<span class="sourceLineNo">131</span>            throw new PersistentObjectException("XML file does not contain an updates list");<a name="line.131"></a>
<span class="sourceLineNo">132</span><a name="line.132"></a>
<span class="sourceLineNo">133</span>        // Save current content (without updates) and updates list<a name="line.133"></a>
<span class="sourceLineNo">134</span>        this.current = (Document)result.getNode();<a name="line.134"></a>
<span class="sourceLineNo">135</span>        this.updates.clear();<a name="line.135"></a>
<span class="sourceLineNo">136</span>        this.updates.addAll(updateNames);<a name="line.136"></a>
<span class="sourceLineNo">137</span>    }<a name="line.137"></a>
<span class="sourceLineNo">138</span><a name="line.138"></a>
<span class="sourceLineNo">139</span>    @Override<a name="line.139"></a>
<span class="sourceLineNo">140</span>    public String toString() {<a name="line.140"></a>
<span class="sourceLineNo">141</span>        return this.getClass().getSimpleName() + "[" + this.systemId + "]";<a name="line.141"></a>
<span class="sourceLineNo">142</span>    }<a name="line.142"></a>
<span class="sourceLineNo">143</span>}<a name="line.143"></a>
<span class="sourceLineNo">144</span><a name="line.144"></a>




























































</pre>
</div>
</body>
</html>
